<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template iset_index</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.iset__index_8hpp" title="Header &lt;boost/interprocess/indexes/iset_index.hpp&gt;">
<link rel="prev" href="classboost_1_1interprocess_1_1flat__map__index.html" title="Class template flat_map_index">
<link rel="next" href="classboost_1_1interprocess_1_1iunordered__set__index.html" title="Class template iunordered_set_index">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1interprocess_1_1flat__map__index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.iset__index_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1interprocess_1_1iunordered__set__index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template iset_index</span></h2>
<p>boost::interprocess::iset_index</p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.iset__index_8hpp" title="Header &lt;boost/interprocess/indexes/iset_index.hpp&gt;">boost/interprocess/indexes/iset_index.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MapConfig<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html" title="Class template iset_index">iset_index</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">iset_index_aux</span><span class="special">::</span><span class="identifier">index_t</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">iterator</span>           <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1af3e0bb5303cffd63331204c187b2ad90"></a><span class="identifier">iterator</span><span class="special">;</span>          
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">const_iterator</span>     <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a1e4dbdc424c2f2a081f72ea6b2b35310"></a><span class="identifier">const_iterator</span><span class="special">;</span>    
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">insert_commit_data</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1af10ff789b1ccb0a928db6126b3a6a018"></a><span class="identifier">insert_commit_data</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">value_type</span>         <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a6a4132df4419f37fbe3d3d78d1775e00"></a><span class="identifier">value_type</span><span class="special">;</span>        
  <span class="keyword">typedef</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">compare_key_type</span>    <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a89b8f8376ee43eabb6171b026c7e7fd7"></a><span class="identifier">compare_key_type</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">value_type</span>                     <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a50d9b2af1f358a587b246340aa83d0b1"></a><span class="identifier">index_data_t</span><span class="special">;</span>      

  <span class="comment">// <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#id27-bb">public member functions</a></span>
  <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a50775fb8faed5fb5b8d160dc0b199a1c"><span class="identifier">iset_index</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ab61ddd9fb1dd9da7e571d5f82a6f1c11"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a5193e3b8558dbe4b07d1da11beee1408"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a1690ef84f3e2fdbbc32babfd941c6a93"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">const_iterator</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a6277d539cc41bb30b8f6a5821677093a"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
  <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ad218f5c271b89d77a9c0a760804716d2"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1interprocess_1_1iset__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ada1b9e214e63034b302b230b69e27171"><span class="identifier">insert_commit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">index_data_t</span> <span class="special">&amp;</span><span class="special">,</span> 
                         <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.16.19.3.28.4.4"></a><h2>Description</h2>
<p>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments*<span style="color: red">&lt;zwj&gt;&lt;/zwj&gt;</span>/ </p>
<div class="refsect2">
<a name="id-1.3.16.19.3.28.4.4.3"></a><h3>
<a name="id27-bb"></a><code class="computeroutput">iset_index</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a50775fb8faed5fb5b8d160dc0b199a1c"></a><span class="identifier">iset_index</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructor. Takes a pointer to the segment manager. Can throw </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ab61ddd9fb1dd9da7e571d5f82a6f1c11"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre>
<p>This reserves memory to optimize the insertion of n elements in the index </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a5193e3b8558dbe4b07d1da11beee1408"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a1690ef84f3e2fdbbc32babfd941c6a93"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> key<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1a6277d539cc41bb30b8f6a5821677093a"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
<a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ad218f5c271b89d77a9c0a760804716d2"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> key<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1iset__index_1ada1b9e214e63034b302b230b69e27171"></a><span class="identifier">insert_commit</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">index_data_t</span> <span class="special">&amp;</span> v<span class="special">,</span> 
                       <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2005-2024 Ion Gaztanaga<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1interprocess_1_1flat__map__index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.iset__index_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1interprocess_1_1iunordered__set__index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
